home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / share / pyshared / UpdateManager / ReleaseNotesViewer.py < prev    next >
Encoding:
Python Source  |  2009-11-02  |  7.2 KB  |  190 lines
  1. # ReleaseNotesViewer.py
  2. #  
  3. #  Copyright (c) 2006 Sebastian Heinlein
  4. #  
  5. #  Author: Sebastian Heinlein <sebastian.heinlein@web.de>
  6. #
  7. #  This modul provides an inheritance of the gtk.TextView that is 
  8. #  aware of http URLs and allows to open them in a browser.
  9. #  It is based on the pygtk-demo "hypertext".
  10. # 
  11. #  This program is free software; you can redistribute it and/or 
  12. #  modify it under the terms of the GNU General Public License as 
  13. #  published by the Free Software Foundation; either version 2 of the
  14. #  License, or (at your option) any later version.
  15. # 
  16. #  This program is distributed in the hope that it will be useful,
  17. #  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19. #  GNU General Public License for more details.
  20. # 
  21. #  You should have received a copy of the GNU General Public License
  22. #  along with this program; if not, write to the Free Software
  23. #  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  24. #  USA
  25.  
  26.  
  27. import pygtk
  28. import gtk
  29. import pango
  30. import subprocess
  31. import os
  32.  
  33. class ReleaseNotesViewer(gtk.TextView):
  34.     def __init__(self, notes):
  35.         """Init the ReleaseNotesViewer as an Inheritance of the gtk.TextView.
  36.            Load the notes into the buffer and make links clickable"""
  37.         # init the parent
  38.         gtk.TextView.__init__(self)
  39.         # global hovering over link state
  40.         self.hovering = False
  41.         self.first = True
  42.         # setup the buffer and signals
  43.         self.set_property("editable", False)
  44.         self.set_cursor_visible(False)
  45.         self.buffer = gtk.TextBuffer()
  46.         self.set_buffer(self.buffer)
  47.         self.buffer.set_text(notes)
  48.         self.connect("event-after", self.event_after)
  49.         self.connect("motion-notify-event", self.motion_notify_event)
  50.         self.connect("visibility-notify-event", self.visibility_notify_event)
  51.         # search for links in the notes and make them clickable
  52.         self.search_links()
  53.  
  54.     def tag_link(self, start, end, url):
  55.         """Apply the tag that marks links to the specified buffer selection"""
  56.         tag = self.buffer.create_tag(None, foreground="blue",
  57.                                      underline=pango.UNDERLINE_SINGLE)
  58.         tag.set_data("url", url)
  59.         self.buffer.apply_tag(tag , start, end)
  60.  
  61.     def search_links(self):
  62.         """Search for http URLs in the buffer and call the tag_link method
  63.            for each one to tag them as links"""
  64.         # start at the beginning of the buffer
  65.         iter = self.buffer.get_iter_at_offset(0)
  66.         while 1:
  67.             # search for the next URL in the buffer
  68.             ret = iter.forward_search("http://", gtk.TEXT_SEARCH_VISIBLE_ONLY,
  69.                                       None)
  70.             # if we reach the end break the loop
  71.             if not ret:
  72.                 break
  73.             # get the position of the protocol prefix
  74.             (match_start, match_end) = ret
  75.             match_tmp = match_end.copy()
  76.             while 1:
  77.                 # extend the selection to the complete URL
  78.                 if match_tmp.forward_char():
  79.                     text =  match_end.get_text(match_tmp)
  80.                     if text in (" ", ")", "]", "\n", "\t"):
  81.                         break
  82.                 else:
  83.                     break
  84.                 match_end = match_tmp.copy()
  85.             # call the tagging method for the complete URL
  86.             url = match_start.get_text(match_end)
  87.             self.tag_link(match_start, match_end, url)
  88.             # set the starting point for the next search
  89.             iter = match_end
  90.  
  91.     def event_after(self, text_view, event):
  92.         """callback for mouse click events"""
  93.         # we only react on left mouse clicks
  94.         if event.type != gtk.gdk.BUTTON_RELEASE:
  95.             return False
  96.         if event.button != 1:
  97.             return False
  98.  
  99.         # try to get a selection
  100.         try:
  101.             (start, end) = self.buffer.get_selection_bounds()
  102.         except ValueError:
  103.             pass
  104.         else:
  105.             if start.get_offset() != end.get_offset():
  106.                 return False
  107.  
  108.         # get the iter at the mouse position
  109.         (x, y) = self.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
  110.                                               int(event.x), int(event.y))
  111.         iter = self.get_iter_at_location(x, y)
  112.         
  113.         # call open_url if an URL is assigned to the iter
  114.         tags = iter.get_tags()
  115.         for tag in tags:
  116.             url = tag.get_data("url")
  117.             if url != "":
  118.                 self.open_url(url)
  119.                 break
  120.  
  121.     def open_url(self, url):
  122.         """Open the specified URL in a browser"""
  123.         # Find an appropiate browser
  124.         if os.path.exists("/usr/bin/exo-open"):
  125.             command = ["exo-open", url]
  126.         elif os.path.exists('usr/bin/gnome-open'):
  127.             command = ['gnome-open', url]
  128.         else:
  129.             command = ['x-www-browser', url]
  130.  
  131.         # Avoid to run the browser as user root
  132.         if os.getuid() == 0 and os.environ.has_key('SUDO_USER'):
  133.             command = ['sudo', '-u', os.environ['SUDO_USER']] + command
  134.  
  135.         subprocess.Popen(command)
  136.  
  137.     def motion_notify_event(self, text_view, event):
  138.         """callback for the mouse movement event, that calls the
  139.            check_hovering method with the mouse postition coordiantes"""
  140.         x, y = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET,
  141.                                                  int(event.x), int(event.y))
  142.         self.check_hovering(x, y)
  143.         self.window.get_pointer()
  144.         return False
  145.     
  146.     def visibility_notify_event(self, text_view, event):
  147.         """callback if the widgets gets visible (e.g. moves to the foreground)
  148.            that calls the check_hovering method with the mouse position
  149.            coordinates"""
  150.         (wx, wy, mod) = text_view.window.get_pointer()
  151.         (bx, by) = text_view.window_to_buffer_coords(gtk.TEXT_WINDOW_WIDGET, wx,
  152.                                                      wy)
  153.         self.check_hovering(bx, by)
  154.         return False
  155.  
  156.     def check_hovering(self, x, y):
  157.         """Check if the mouse is above a tagged link and if yes show
  158.            a hand cursor"""
  159.         _hovering = False
  160.         # get the iter at the mouse position
  161.         iter = self.get_iter_at_location(x, y)
  162.         
  163.         # set _hovering if the iter has the tag "url"
  164.         tags = iter.get_tags()
  165.         for tag in tags:
  166.             url = tag.get_data("url")
  167.             if url != "":
  168.                 _hovering = True
  169.                 break
  170.  
  171.         # change the global hovering state
  172.         if _hovering != self.hovering or self.first == True:
  173.             self.first = False
  174.             self.hovering = _hovering
  175.             # Set the appropriate cursur icon
  176.             if self.hovering:
  177.                 self.get_window(gtk.TEXT_WINDOW_TEXT).\
  178.                         set_cursor(gtk.gdk.Cursor(gtk.gdk.HAND2))
  179.             else:
  180.                 self.get_window(gtk.TEXT_WINDOW_TEXT).\
  181.                         set_cursor(gtk.gdk.Cursor(gtk.gdk.LEFT_PTR))
  182.  
  183. if __name__ == "__main__":
  184.     # some simple test code
  185.     win = gtk.Window()
  186.     rv = ReleaseNotesViewer(open("../DistUpgrade/ReleaseAnnouncement").read())
  187.     win.add(rv)
  188.     win.show_all()
  189.     gtk.main()
  190.